auto-docs: Update Admin API docs for v25.3.4 #50
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
📝 WalkthroughWalkthroughThe pull request updates the OpenAPI specification file Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes
Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
ℹ️ Redpanda/admin (branch: v1) API content change detectedNo structural change, nothing to display. Powered by Bump.sh |
ℹ️ Redpanda/admin (branch: v2) API content change detectedNo structural change, nothing to display. Powered by Bump.sh |
ℹ️ Redpanda/http-proxy API content change detectedNo structural change, nothing to display. Powered by Bump.sh |
ℹ️ Redpanda/schema-registry API content change detectedNo structural change, nothing to display. Powered by Bump.sh |
ℹ️ Redpanda/cloud-dataplane API content change detectedNo structural change, nothing to display. Powered by Bump.sh |
ℹ️ Redpanda/cloud-controlplane API content change detectedNo structural change, nothing to display. Powered by Bump.sh |
vbotbuildovich
force-pushed
the
auto-docs/admin-api
branch
from
284375a to
63bb5b1
Compare
vbotbuildovich
changed the title
Feediver1
reviewed
Jan 13, 2026
| $ref: "#/components/schemas/connect.error" | ||
| description: Error | ||
| summary: ListKafkaConnections | ||
| summary: ListKafkaConnections returns information about the cluster's Kafka connections, collected and ordered across all brokers. |
Contributor
There was a problem hiding this comment.
Suggested change
| summary: ListKafkaConnections returns information about the cluster's Kafka connections, collected and ordered across all brokers. | |
| summary: ListKafkaConnections returns information about the cluster's Kafka connections, collected and ordered across all brokers. |
Feediver1
reviewed
Jan 13, 2026
| /redpanda.core.admin.v2.ShadowLinkService/FailOver: | ||
| post: | ||
| description: Fails over a shadow link or a single shadow topic for disaster recovery. | ||
| description: Fails over a shadow link or a single shadow topic |
Contributor
There was a problem hiding this comment.
Suggested change
| description: Fails over a shadow link or a single shadow topic | |
| description: Fails over a shadow link or a single shadow topic. |
Feediver1
reviewed
Jan 13, 2026
| Returns information about a shadow topic on a shadow link. | ||
| A shadow topic is a resource created automatically by a shadow link. The | ||
| shadow topic 'shadows' a topic on a source cluster, mirroring the data | ||
| This operation returns information about a Shadow Topic on a Shadow Link. |
Contributor
There was a problem hiding this comment.
Our DR docs do not use this capitalization style. The enterprise feature is Shadowing. Docs use shadow linking, and shadow topics.
Feediver1
reviewed
Jan 13, 2026
| $ref: "#/components/schemas/connect.error" | ||
| description: Error | ||
| summary: GetShadowTopic | ||
| summary: This operation returns information about a Shadow Topic on a Shadow Link. A Shadow Topic is a resource created automatically by a Shadow Link. The Shadow Topic 'shadows' a topic on a source cluster, mirroring the data and properties of that topic. |
Contributor
There was a problem hiding this comment.
Same comment re capitalization
Feediver1
reviewed
Jan 13, 2026
| description: |- | ||
| Returns a list of all shadow topics on a shadow link and | ||
| their status. | ||
| This operation returns a list of all Shadow Topics on a Shadow Link and |
Contributor
There was a problem hiding this comment.
Suggested change
| This operation returns a list of all Shadow Topics on a Shadow Link and | |
| This operation returns a list of all shadow topics on a shadow link and |
Feediver1
reviewed
Jan 13, 2026
| $ref: "#/components/schemas/connect.error" | ||
| description: Error | ||
| summary: ListShadowTopics | ||
| summary: This operation returns a list of all Shadow Topics on a Shadow Link and their status |
Contributor
There was a problem hiding this comment.
Suggested change
| summary: This operation returns a list of all Shadow Topics on a Shadow Link and their status | |
| summary: This operation returns a list of all shadow topics on a shadow link and their status |
Contributor
|
Using a specific tagged release ( |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the latest OpenAPI spec for version v25.3.4 of the Redpanda Admin API: